Object ProImm

Function ProImmParamsGet


Description
Retrieves the information about the Imm from immparams handle. The handle must be filled earlier by the functions ProImmDialog() or ProImmGetFromModel().
Synopsis
#include <ProImm.h>
ProErrorProImmParamsGet(
ProImmParams immparams
/* (In)
Pointer to the ImmParam handle
*/
ProName machine_name
/* (Out)
name of IMM (allocated by caller);
*/
ProCharName** p_param_names
/* (Out)
ProArray of Imm parameter names; The user must pass a pre-allocated array. If the array is reused, new elements will be appended to the existing elements unless the array size is reset to 0 with ProArraySizeSet.
*/
ProName** p_param_values
/* (Out)
ProArray of Imm parameter values; The user must pass a pre-allocated array. If the array is reused, new elements will be appended to the existing elements unless the array size is reset to 0 with ProArraySizeSet.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSThe input argument is invalid.

Sample Code References:

  1. pt_examples ( TestImm.c )